package com.pig4cloud.pig.common.swagger.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @desc 排除属性的值(swagger2 3.0)
 * 例如：
 * R<OutParamsVo> paramsIgn(@ApiIgn(value={"id,appType"},annotation = {"name@姓名"}) @RequestBody  InParamsVo params)
 */
@Target({ElementType.PARAMETER, ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiIgn {
    /**
     * 排除字段，子可以多个逗号分隔
     * @return
     */
    String[] value() default {};

    /**
     * 新的字段描述，例如:id@必填，长度大于3
     * @return
     */
    String[] annotation() default {};


    /**
     * 自定义 Model的名字，非必填（为空系统指定）
     */
    String modelName() default "";
}
